--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
docs/en/tools.md dev (c9f60cc5) Text, 6.42 KB
Tc9d1d9# Tools and utilities
The **Tools** page groups mesh diagnostics and helper apps. Each tool opens its own view with a back link to the grid.
Tc9d1d9## Network diagnostics
| Tool | Purpose |
| ------------------ | -------------------------------------------------- |
| Ping | Measure round-trip time to a reachable destination |
| RNProbe | Probe whether a destination answers |
| RNPath | Inspect the path table |
| RNPath-trace | Trace hops toward a destination |
| RNStatus | Read node status information |
| Network visualiser | Graph view of topology (also in main navigation) |
Use these when messages or pages fail despite interfaces showing as enabled.
Tc9d1d9## File transfer and shell
| Tool | Purpose |
| ------------ | -------------------------------------------------------- |
| RNCP | Send or fetch files over Reticulum |
| RNS FileSync | Sync a directory with peers over Ta5d6ff`rns_filesync.filesync` |
| RNSH | Remote shell sessions with streamed output |
RNCP progress events arrive on the WebSocket as Ta5d6ff`rncp.transfer.progress`.
FileSync progress and peer events use Ta5d6ff`filesync.sync.progress`, Ta5d6ff`filesync.peer.connected`, Ta5d6ff`filesync.peer.disconnected`, Ta5d6ff`filesync.file.updated`, Ta5d6ff`filesync.file.deleted`, and Ta5d6ff`filesync.error`.
FileSync uses the bundled Ta5d6ff`rns_filesync` package and keeps sync state under the active identity storage directory.
Tc9d1d9## Messaging helpers
| Tool | Purpose |
| ----------------- | ----------------------------------------------- |
| Propagation nodes | Manage LXMF propagation nodes and sync |
| Forwarder | Configure LXMF forwarding rules between aliases |
| Sieve filters | Pattern-based inbound message filtering (beta) |
| Message blocklist | Block known unwanted content (beta) |
| Paper message | Create or ingest LXMF URIs and QR workflows |
| Bots | Run subprocess LXMF bots from templates |
Bot templates include echo, note, and reminder starters. They use the bundled Ta5d6ff`lxmfy` package.
Tc9d1d9## Content and publishing
| Tool | Purpose |
| ------------- | ------------------------------------- |
| Mesh Server | Host NomadNet-compatible page nodes |
| Micron editor | Edit Ta5d6ff`.mu` pages locally |
| Documentation | MeshChatX guides and Reticulum manual |
Tc9d1d9## Configuration editors
| Tool | Purpose |
| ----------------------- | --------------------------------------- |
| Reticulum config editor | Edit raw Reticulum configuration |
| Repository server | Host Python wheels for offline installs |
Tc9d1d9## Hardware and translation
| Tool | Purpose |
| ------------- | ---------------------------------------------------- |
| RNode flasher | Flash or update RNode firmware |
| Translator | Translate text via Argos Translate or LibreTranslate |
Translator calls respect **privacy mode**. When privacy mode blocks outbound HTTP, external translation endpoints are not contacted.
Tc9d1d9## Debugging
| Tool | Purpose |
| ---------- | ----------------------------- |
| Debug logs | View backend debug log stream |
Tc9d1d9## Coming soon
The registry marks **RNS Tunnel** as coming soon. It does not have a route in the current release.
Tc9d1d9## Relay chat server
When Ta5d6ff`rrc_enabled` is on, you can run a local RRC hub from relay chat server settings. Hubs announce aspect Ta5d6ff`rrc.hub`. Client UI lives under **Relay chat** in the main navigation.
Tc9d1d9## Plugins
Installed plugins can add rows to **Tools** and **Navigation** through contribution manifests. Example bundled plugin: **Bug Reports** (Ta5d6ff`com.meshchatx.mcx-bugs`) for sending redacted debug logs to an Ta5d6ff`mcx-bugs-v1` collector (or running a collector yourself).
Plugins are capability-gated, not fully open-ended: they cannot rewrite core MeshChatX. Supported packaged runtimes are **frontend JS** (Worker), optional **backend WASM** (wasmtime), and optional **backend Python** (Ta5d6ff`backend.type: "python"`). Install sources include ZIP archives and single-file **WASM bundles** with embedded Ta5d6ff`plugin.json` / files / optional RSG signature.
ZIP and WASM installs show a confirmation dialog with requested permissions, scanned/declared external HTTP URLs, signature status (unsigned / signed / trusted / invalid), and heuristic security findings. Invalid signatures hard-block install. You can deny individual grants and optionally trust a valid signer. After install, MeshChatX stores an integrity hash and auto-disables tampered plugins.
Optional **Sideband-compatible** plugins load flat Ta5d6ff`*.py` files from a configured directory when the master switch is enabled (danger confirm). They run in-process with full host access. Optional sibling Ta5d6ff`filename.py.rsg` signatures are verified over file bytes.
Sign packages with Ta5d6ff`scripts/sign-plugin.py` (Ta5d6ff`sign|verify` for Ta5d6ff`-dir|-zip|-wasm|-py`) using a Reticulum identity (Ta5d6ff`rnid` or in-process Ta5d6ff`RNS.Identity`). MeshChatX plugin signing uses signature file Ta5d6ff`meshchatx.plugin.rsg` and WASM custom sections Ta5d6ff`meshchatx.plugin` / Ta5d6ff`meshchatx.files` / Ta5d6ff`meshchatx.signature`.
Disable packaged plugins at startup with Ta5d6ff`--disable-plugins` if you need a minimal surface.
Tc9d1d9## Command palette
Press the command palette shortcut (configured in settings) to jump to tools and pages without returning to the grid.
Tc9d1d9## Choosing a tool
Ta5d6ff```
Symptom Tool to try first
------------------------------- ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ ------------------------------------------------ -----------------
No peers visible Interfaces, then RNPath
Message stuck sending RNPath, Propagation nodes
Cannot reach Nomad page Ping, RNProbe
Need to push a file RNCP
Remote administration RNSH (with care)
Want offline Python packages Repository server
```
Tc9d1d9## See also
Tff7b72- **Reticulum interfaces** for transport setup
Tff7b72- **LXMF messaging** and **Nomad Network** for feature-specific workflows
Tff7b72- [Tff7b72Plugins](Te6edf3plugins.md) for extending MeshChatX functionality
Tff7b72- **Documentation** for offline manuals
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────